Skip to content

refactor: Added comment about setting of env variable in Docker file#238

Merged
Roopan-Microsoft merged 1 commit intomainfrom
sfi-code-fix
Oct 30, 2025
Merged

refactor: Added comment about setting of env variable in Docker file#238
Roopan-Microsoft merged 1 commit intomainfrom
sfi-code-fix

Conversation

@Prajwal-Microsoft
Copy link
Collaborator

Purpose

  • ...
    This pull request adds inline comments to several places in the codebase where DefaultAzureCredential is instantiated using an environment variable. The comments clarify that the environment variable is intentionally set in the Docker file, addressing a CodeQL warning (SM05137). No logic or behavior is changed; these are documentation improvements for static analysis and code reviewers.

Key documentation updates:

Credential Initialization Comments:

  • Added comments to all instances where DefaultAzureCredential is constructed with DefaultAzureCredential.DefaultEnvironmentVariableName, indicating that the environment variable is set in the Docker file to address CodeQL warning SM05137. This affects the following files and constructors:
    • AzureStorageQueueService in AzureStorageQueueService.cs
    • GetBlobClientFromConnectionString in StorageAccessUtil.cs
    • AzureAIDocIntelEngine in AzureAIDocIntelEngine.cs
    • AzureAISearchMemory in AzureAISearchMemory.cs
    • AzureBlobsStorage in AzureBlobsStorage.cs
    • AzureOpenAITextEmbeddingGenerator in AzureOpenAITextEmbeddingGenerator.cs
    • AzureOpenAITextGenerator in AzureOpenAITextGenerator.cs
    • AzureQueuesPipeline in AzureQueuesPipeline.cs

Does this introduce a breaking change?

  • Yes
  • No

Golden Path Validation

  • I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation

  • I have validated the deployment process successfully and all services are running as expected with this change.

What to Check

Verify that the following are valid

  • ...

Other Information

@Roopan-Microsoft Roopan-Microsoft merged commit 0c0f2d5 into main Oct 30, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants